modelit.layout.Divider

Extends: modelit.layout.Frame & modelit.layout.Node & hgsetget & handle & matlab.mixin.Heterogeneous

A vertical or horizontal frame divider. The user can drag the divider to resize frames.

Properties

active

  Visibility of this frame.
  Boolean, default value: true
  If true: This frame is visible
  If false: This frame is invisible

Help for modelit.layout.Divider/active is inherited from superclass MODELIT.LAYOUT.FRAME

allowsChildren

  True if the node is able to have children.
  Boolean, default value: true

Help for modelit.layout.Divider/allowsChildren is inherited from superclass MODELIT.LAYOUT.NODE

backgroundcolor

  The background of the frame.
  RGB triple, default value []

Help for modelit.layout.Divider/backgroundcolor is inherited from superclass MODELIT.LAYOUT.FRAME

border

  The frame's border
  A modelit.layout.AbstractPainter implementation

Help for modelit.layout.Divider/border is inherited from superclass MODELIT.LAYOUT.FRAME

children (Read-only)

  Array of children,
  May be [] if this node has no children.
  Children are ordered according to their rank.
  Array, default value: []

Help for modelit.layout.Divider/children is inherited from superclass MODELIT.LAYOUT.NODE

clipframe

  The clipframe.
  Components outside this frame are hidden
  A modelit.layout.Frame, default value []

Help for modelit.layout.Divider/clipframe is inherited from superclass MODELIT.LAYOUT.FRAME

clipping

  The clipping mode.
  If true, clip components to clipframe, if false do not clip.
  Boolean, default value false

Help for modelit.layout.Divider/clipping is inherited from superclass MODELIT.LAYOUT.FRAME

enable

  The enable status of this frame.
  Boolean, default value: true
  If true: This frame is enabled
  If false: This frame is disabled

Help for modelit.layout.Divider/enable is inherited from superclass MODELIT.LAYOUT.FRAME

exitfunction

  Function that is called when frame becomes inactive.
  Function handle, default value: [].

Help for modelit.layout.Divider/exitfunction is inherited from superclass MODELIT.LAYOUT.FRAME

lineprops

  Property of line, if used as border
  zie Matlab - line voor meer informatie
  \ VOORBEELD: ...,'lineprops',lm_lineprops('color','k','shadowed',0 ),...
  ...,'lineprops',lm_lineprops,...
  'shadowed'       (default true)
                   If true a ahdow effect will be created by drawing a second line.

Help for modelit.layout.Divider/lineprops is inherited from superclass MODELIT.LAYOUT.FRAME

maxpixelsize

  Maximum pixelsize of this frame.
  1x2 array, default value: [Inf Inf]

Help for modelit.layout.Divider/maxpixelsize is inherited from superclass MODELIT.LAYOUT.FRAME

minmarges

  Margin in pixels for this frame [LEFT LOWER RIGHT UPPER].
  The margin is relative to the parent frame
  1x4 array: default value: [0 0 0 0]

Help for modelit.layout.Divider/minmarges is inherited from superclass MODELIT.LAYOUT.FRAME

normposition

  Normalized position of the root frame [x y width height].
  1x4 array, default value: []
  Note: Only for the root frame

Help for modelit.layout.Divider/normposition is inherited from superclass MODELIT.LAYOUT.FRAME

normsize

  Normalized size of the frame.
  1x2 array: Default value: [1 1]
  NOTE: One may specify NaN for 1 or both dimensions. In
  this case the normalized size will be computed form the active siblings.

Help for modelit.layout.Divider/normsize is inherited from superclass MODELIT.LAYOUT.FRAME

outborderpos

  The outer limits of this Frame.

Help for modelit.layout.Divider/outborderpos is inherited from superclass MODELIT.LAYOUT.FRAME

painter

  A background painter.
  A modelit.layout.AbstractPainter implementation

Help for modelit.layout.Divider/painter is inherited from superclass MODELIT.LAYOUT.FRAME

parent

  This node's parent, or empty if this node has no parent.
  modelit.layout.Node or [], default value: []

Help for modelit.layout.Divider/parent is inherited from superclass MODELIT.LAYOUT.NODE

patchprops

  Eigenschappen van de patch die het frame markeert
  zie Matlab - patch voor meer informatie
  VOORBEELD: ...,'patchprops',lm_patchprops('facec',C.WINCOLOR,'linew',1),...
  (default: [])

Help for modelit.layout.Divider/patchprops is inherited from superclass MODELIT.LAYOUT.FRAME

pixelposition

  Pixelposition of the root frame [x y width height].
  1x4 array: default value: []
  Note: Only for the root frame

Help for modelit.layout.Divider/pixelposition is inherited from superclass MODELIT.LAYOUT.FRAME

pixelsize

  Size of the frame in pixels.
  1x2 array, Default value: [0 0]
  NOTE: One may specify NaN for one or both dimensions. In
  this case the pixelsize will be computed form the active siblings.

Help for modelit.layout.Divider/pixelsize is inherited from superclass MODELIT.LAYOUT.FRAME

rank

  Relative position of the node
  When ordering horizontally: low rank goes left. High rank goes right.
  When ordering vertically. Low rank goes above. High rank goes below.
  NOTE: only the relative ranks are important.
  Integer, default value: 0

Help for modelit.layout.Divider/rank is inherited from superclass MODELIT.LAYOUT.NODE

splithor

  Orientation of this frame.
  Boolean: default value: true.
  If true: Children will be stacked horizontally.
  If false: Children will be stacked vertically.

Help for modelit.layout.Divider/splithor is inherited from superclass MODELIT.LAYOUT.FRAME

tag

  String with user specified object identifier.
  Use this tag i.c.w. gch('tag', parent) to find a modelit.layout.Frame
  String, default value: ''.

Help for modelit.layout.Divider/tag is inherited from superclass MODELIT.LAYOUT.FRAME

title

  Frame title
  modelit.layout.Title, default value: ''

Help for modelit.layout.Divider/title is inherited from superclass MODELIT.LAYOUT.FRAME

userdata

  User specified data for this frame.
  Array, default value: []

Help for modelit.layout.Divider/userdata is inherited from superclass MODELIT.LAYOUT.FRAME

Methods

Divider

Modelit.ui.TabPane constructor

CALL:

   obj = modelit.ui.TabPane(varargin)

INPUT:

   varargin:
    parameter-value pairs, see the component properties for a
    description of the parameters and their values

splitFrame

Calculate position of frame.

CALL:

   splitFrame(obj)

INPUT:

   obj:
     modelit.layout.Frame

OUTPUT:

   No direct output
      ChildFrames:
          sub-frames met bijgewerkte eigenschappen:
              activenode
              inborderpos
              outborderpos
     showslider:
          true wanneer hoogte viewport<required
     VERTICALSHIFT:
          verticale verschuiving oiv slider

Help for modelit.layout.Divider/splitFrame is inherited from superclass MODELIT.LAYOUT.FRAME

removeComponents

Removes all components in this frame.

CALL:

   removeComponents(obj, excepted)

INPUT:

   obj:
     modelit.layout.Frame
   excepted (optional, default value: []):
     array with handles of components that should not be removed

OUTPUT:

   No output

Help for modelit.layout.Divider/removeComponents is inherited from superclass MODELIT.LAYOUT.FRAME

remove

Remove this frame from the tree.

CALL:

   remove(obj)

INPUT:

   obj:
     modelit.layout.Frame

OUTPUT:

   No output

Help for modelit.layout.Divider/remove is inherited from superclass MODELIT.LAYOUT.FRAME

getComponentCount

Returns the number of components in this frame.

CALL:

   value = getComponentCount(obj)

INPUT:

   obj:
     modelit.layout.Frame

OUTPUT:

   value:
     integer with the number of components in this frame

Help for modelit.layout.Divider/getComponentCount is inherited from superclass MODELIT.LAYOUT.FRAME

getComponents

Returns this frame's components.

CALL:

   value = getComponents(obj)

INPUT:

   obj:
     modelit.layout.Frame

OUTPUT:

   value:
     list of handles with this frame's components.

Help for modelit.layout.Divider/getComponents is inherited from superclass MODELIT.LAYOUT.FRAME

ancestor

Returns the handle of the closest ancestor of the frame
that matches one of the types in type,

CALL:

   p = ancestor(obj, type)

INPUT:

   obj:
     modelit.layout.Frame
   type:
     String or cell array of strings (types)

OUTPUT:

   p:
      handle of the closest ancestor of the frame that matches one of the types in type

Help for modelit.layout.Divider/ancestor is inherited from superclass MODELIT.LAYOUT.FRAME

getappdata

Get application data of this frame.

CALL:

   value = getappdata(obj, property)

INPUT:

   obj:
     modelit.layout.Frame
   property:
     string of application data field

OUTPUT:

   value:
     application data stored in application data field

Help for modelit.layout.Divider/getappdata is inherited from superclass MODELIT.LAYOUT.FRAME

setappdata

Set application data of this frame.

CALL:

   value = getappdata(obj, property)

INPUT:

   obj:
     modelit.layout.Frame
   property:
     string of application data field
   value:
     application data to be stored in application data field

OUTPUT:

    No output

Help for modelit.layout.Divider/setappdata is inherited from superclass MODELIT.LAYOUT.FRAME

addComponent

Add a component to a modelit.layout.Frame

CALL:

   addComponent(hframe, hobj, varargin)

INPUT:

      hobj  :
 object or array of handles or jacontrol object
      hframe: 
  frame to link to
      property: 
  char string containg property name
      value:
  corresponding property value. Note: property/value
              combinations may als be passed on as a tructure.
 
      <propertye, value>
             clipframe
                    see lm_resize
             clipping [0 or 1]
                    clip object if out of frame borders
             enable
                    Default: enable status is copied from application data
                    "enable" from frame.
                    Note
                    <on> and <off> is supported. <inactive> is not supported.
                         Object  |          Frame
                         enabled |       enabled status
                                  'Frame=on' 'Frame=off' 'Frame=inactive'
                         ==========================================
                         0  ==>   'off'      'off'       <not supported>
                         1  ==>   'on'       'off'       <not supported>
                         2  ==>   'inactive' 'off'       <not supported>
                         3  ==>   'off'      'off'       <not supported>
                         4  ==>   'on'       'on'        <not supported>
                         5  ==>   'inactive' 'inactive'  <not supported>
             keeppixelsize : is 1 maintain pixel height and width while alignigning in matrix
             keepypos: if 1 ==> position of slider has no effect on this
                                object
             normpos [X,Y,WIDTH,HEIGHT]
                    normalized position relative to LL corner of frame
             pixelpos [X,Y,WIDTH,HEIGHT]
                    pixel position relative to LL corner of frame
             visible
                         0  ==> do not show
                         1  ==> show
             row: align on position (row,col) in matrix
             col: align on position (row,col) in matrix

OUTPUT:

        none
 
    AFFECTED OBJECTS
        -1- affected application data of frame:
            when an object is linked to a frame, this will affect the following
            fields of application data of this frame:
              uichildren
              textchildren
              children
              javachildren
        -2- affected properties of object:
              parent: when object-parent differs from frame-parent
              units : set to "pixel" when object is of type
                      text,uicontainer,hgjavacomponent
        -3- affected application data of object, required:
              normpos
              pixelpos
              visible
              enable
              clipping
              keepypos
        -4- affected application data of object, optional:
              clipframe
              row
              col
              keeppixelsize

Help for modelit.layout.Divider/addComponent is inherited from superclass MODELIT.LAYOUT.FRAME

getClipRectangle

Compute clipping rectangle

CALL:

   [fxmin, fxmax, fymin, fymax] = getClipRectangle(clipframe)

INPUT:

   clipframe:
   frames
   borderpos

OUTPUT:

   rect:

Help for modelit.layout.Divider/getClipRectangle is inherited from superclass MODELIT.LAYOUT.FRAME

initializeTreetops

Initialise de variabele 'inborderpos' voor de frames die geen parent hebben
In tegenstelling tot frames met een parent, wordt hier de positie bepaald door
de elementen normpos en normpix, waarbij met broers en zussen geen rekening wordt gehouden
normpix wordt vermenigvuldigd met de afmetingen van het scherm
pixelsize wordt daarbij opgeteld

CALL:

    [FrameData, hax] = initializeTreetops(FrameData, hfig)

INPUT:

   FrameData:
     modelit.layout.Frame
   hfig:
     handle of figure

OUTPUT:

   FrameData:
   hax:

Help for modelit.layout.Divider/initializeTreetops is inherited from superclass MODELIT.LAYOUT.FRAME

plotFrame

Position and plot all components in this frame.

CALL:

   plotFrame(frame)

INPUT:

    frame:
      modelit.layout.Frame

OUTPUT:

   No output

Help for modelit.layout.Divider/plotFrame is inherited from superclass MODELIT.LAYOUT.FRAME

updateHgProps

  Update handle graphics properties of object and frame

Help for modelit.layout.Divider/updateHgProps is inherited from superclass MODELIT.LAYOUT.FRAME

hide

Hide all components and decorators of this frame

CALL:

   hide(obj)

INPUT:

   obj:
     modelit.layout.Frame

OUTPUT:

   No output
              if ~isempty(obj.exittext)
                  obj.exittext.visible = false;
                  paint(obj.exittext);
              end

Help for modelit.layout.Divider/hide is inherited from superclass MODELIT.LAYOUT.FRAME

removeAll

Removes all components in this frame

CALL:

   removeAll(obj)

INPUT:

   obj:
     modelit.layout.Frame
   excepted (optional, default value: []):
     array with handles of components that should not be removed

OUTPUT:

   No output

Help for modelit.layout.Divider/removeAll is inherited from superclass MODELIT.LAYOUT.FRAME

find

Find a Frame with the specified tag

CALL:

   h = find(tag, HWIN)

INPUT:

   tag:
    string with tag of Frame to look for
   HWIN:
    handle of figure in which to look for the Frame

OUTPUT:

   h:
    Array of modelit.layout.Frame, possible empty if no Frame with
    specified tag exists

Help for modelit.layout.Divider.find is inherited from superclass MODELIT.LAYOUT.FRAME

storeTree

Stores the tree (root node) in the specified figure

CALL:

   layout = storeTree(HWIN)

INPUT:

   HWIN:
     handle of figure in which to store the tree.
   layout:
     modelit.layout.Frame with the root of the tree

OUTPUT:

    No output

Help for modelit.layout.Divider.storeTree is inherited from superclass MODELIT.LAYOUT.FRAME

retrieveTree

Retrieves the tree (root node) from the specified figure

CALL:

   layout = retrieveTree(HWIN)

INPUT:

   HWIN:
     handle of figure in which the tree is stored.

OUTPUT:

   layout:
     modelit.layout.Frame with the root of the tree

Help for modelit.layout.Divider.retrieveTree is inherited from superclass MODELIT.LAYOUT.FRAME

lm_get

  Helper for migration to new layout manager

Help for modelit.layout.Divider/lm_get is inherited from superclass MODELIT.LAYOUT.FRAME

lm_set

  Helper for migration to new layout manager

Help for modelit.layout.Divider/lm_set is inherited from superclass MODELIT.LAYOUT.FRAME

getPathToRoot

Builds the parents of node up to and including the root node, where the original node is the last element in the returned array.

CALL:

   value = getPathToRoot(obj)

INPUT:

   obj:
     modelit.layout.Node

OUTPUT:

   value:
     list of modelit.layout.Node

Help for modelit.layout.Divider/getPathToRoot is inherited from superclass MODELIT.LAYOUT.NODE

getLevel

Returns the number of levels above this node, i.e. the distance from the root to this node.

CALL:

   value = getLevel(obj)

INPUT:

   obj:
     modelit.layout.Node

OUTPUT:

   value:
     integer

Help for modelit.layout.Divider/getLevel is inherited from superclass MODELIT.LAYOUT.NODE

getDepthFirstList

First order for the subtree starting at the specified node.

CALL:

   list = getDepthFirstList(obj, list)

INPUT:

   obj:
     modelit.layout.Node

OUTPUT:

   list:
     array of modelit.layout.Node in depth-first order

Help for modelit.layout.Divider/getDepthFirstList is inherited from superclass MODELIT.LAYOUT.NODE

getBreadthFirstList

First order for the subtree starting at the specified node.

CALL:

   list = getBreadthFirstList(obj)

INPUT:

   obj:
     modelit.layout.Node

OUTPUT:

   list:
     array of modelit.layout.Node in breadth-first order

Help for modelit.layout.Divider/getBreadthFirstList is inherited from superclass MODELIT.LAYOUT.NODE

getPreviousSibling

Returns the previous sibling of this node.
Returns [] if this node has no parent or if it is the parent's first child.

CALL:

   value = getPreviousSibling(obj)

INPUT:

   obj:
     modelit.layout.Node

OUTPUT:

   value:
     modelit.layout.Node or []

Help for modelit.layout.Divider/getPreviousSibling is inherited from superclass MODELIT.LAYOUT.NODE

getNextSibling

Returns the next sibling of this node.
Returns [] if this node has no parent or if it is the parent's last child.

CALL:

   value = getNextSibling(obj)

INPUT:

   obj:
     modelit.layout.Node

OUTPUT:

   value:
     modelit.layout.Node or []

Help for modelit.layout.Divider/getNextSibling is inherited from superclass MODELIT.LAYOUT.NODE

getSiblings

Gets the siblings (nodes with the same parent) of this node.
Note that this node is its own sibling

CALL:

   value = getSiblings(obj)

INPUT:

   obj:
     modelit.layout.Node

OUTPUT:

   value:
     modelit.layout.Node

Help for modelit.layout.Divider/getSiblings is inherited from superclass MODELIT.LAYOUT.NODE

removeAllChildren

Removes all of this node's children.

CALL:

   removeAllChildren(obj)

INPUT:

   obj:
     modelit.layout.Node

OUTPUT:

   No output

Help for modelit.layout.Divider/removeAllChildren is inherited from superclass MODELIT.LAYOUT.NODE

add

Removes newChild from its parent and makes it a child of this node by adding it to the end of this node's child array.

CALL:

   add(obj, newChild)

INPUT:

   obj:
     modelit.layout.Node
   newChild:
     modelit.layout.Node, node to be added as a child of obj

OUTPUT:

   No output

Help for modelit.layout.Divider/add is inherited from superclass MODELIT.LAYOUT.NODE

isRoot

Returns true if this node is the root of the tree.

CALL:

   obj = isRoot(obj)

INPUT:

   obj:
     modelit.layout.Node

OUTPUT:

   value:
    boolean, true if this node is a root node

Help for modelit.layout.Divider/isRoot is inherited from superclass MODELIT.LAYOUT.NODE

isLeaf

Returns true if this node is a leaf.

CALL:

   value = isLeaf(obj)

INPUT:

   obj:
     modelit.layout.Node

OUTPUT:

   value:
    boolean, true if this node is a leaf (has no children)

Help for modelit.layout.Divider/isLeaf is inherited from superclass MODELIT.LAYOUT.NODE

getRoot

Returns the root of this node.

CALL:

   obj = getRoot(obj)

INPUT:

   obj:
     modelit.layout.Node

OUTPUT:

   obj:
     modelit.layout.Node

Help for modelit.layout.Divider/getRoot is inherited from superclass MODELIT.LAYOUT.NODE

getIndex

Returns the index of this node in its parent's children.

CALL:

   value = getIndex(obj)

INPUT:

   obj:
     modelit.layout.Node

OUTPUT:

   value:
     integer with index of this node in its parent's children, 0 if this node is a root

Help for modelit.layout.Divider/getIndex is inherited from superclass MODELIT.LAYOUT.NODE

getChildCount

Returns the number of children of this node.

CALL:

   value = getChildCount(obj)

INPUT:

   obj:
     modelit.layout.Node

OUTPUT:

   value:
     integer with number of children of this node

Help for modelit.layout.Divider/getChildCount is inherited from superclass MODELIT.LAYOUT.NODE

getChildAt

Returns the child of obj at index childIndex.

CALL:

   value = getChildAt(obj, childIndex)

INPUT:

   obj:
     modelit.layout.Node
   childIndex:
     integer

OUTPUT:

   obj:
     modelit.layout.Node or [] if index exceeds number of children

Help for modelit.layout.Divider/getChildAt is inherited from superclass MODELIT.LAYOUT.NODE

eq

  Returns the objects whose property values match those passed as param-value pairs to the findobj command.

Help for modelit.layout.Divider/eq is inherited from superclass MODELIT.LAYOUT.NODE

findobj

  Returns the objects whose property values match those passed as param-value pairs to the findobj command.

Help for modelit.layout.Divider/findobj is inherited from superclass MODELIT.LAYOUT.NODE